/*
 * Copyright 2011 J. Auer, J. Andert, F.-J. Jendrusch, U. Celebi
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package de.fuberlin.replication.storage;

import de.fuberlin.replication.library.Subset;

/**
 * Data Access Object (DAO) interface for subsets in the replication metadata storage.
 * 
 * @see Subset
 */
public interface SubsetDAO {
	/**
	 * Returns all subsets.
	 * 
	 * @return all subsets.
	 */
	Iterable<Subset> getAll();

	/**
	 * Creates and returns a new subset.
	 * 
	 * @return new subset.
	 */
	Subset create();

	/**
	 * Persistently stores the given subset.
	 * 
	 * @param subset the subset to be stored.
	 */
	void save(Subset subset);

	/**
	 * Deletes the given subset. Should fail (throw an exception) if the subset is not empty.
	 * 
	 * @param subset the subset to be deleted.
	 */
	void delete(Subset subset);
}